Skip to content

docs(onboarding): 帮助用户开始使用 InKCre - #28

Open
xiaoland wants to merge 12 commits into
mainfrom
feat/user-getting-started
Open

docs(onboarding): 帮助用户开始使用 InKCre#28
xiaoland wants to merge 12 commits into
mainfrom
feat/user-getting-started

Conversation

@xiaoland

@xiaoland xiaoland commented Sep 20, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

目标与范围

帮助已经理解 InKCre 基本理念、但尚无实例的用户开始收集、整理并使用自己的信息。应用级 Getting Started 解释 What / Why / How；Self-hosting 是 How 的一条路径，并继续分为 Getting Started 与 Advanced。

  • Web 是用户默认界面，CLI 是 Agent/operator 的补充接口。
  • Neon + Render/Heroku 是 fork 快速部署；高级文档解释数据库初始化、PostgREST、Python Core 与运维责任。
  • RSS、GitHub、Mail、Telegram、Twitter、Memos 各有独立入口；Memos 明确是兼容写入接口而非采集 Source。
  • ChatGPT MCP Sink 位于 Use Your Information；Source Extension 生态开发指南与核心贡献分离。
  • Registry 插件文档合同现在定义完整静态资源快照：精确 Release + global/python/module-federation scope、条件整包纠错、独立内容 origin、blocked/yanked 读取语义；不要求 Markdown 或指定 SSG。
  • 第一方 VitePress 模板由本仓库统一维护，producer 复用主题、版本/渠道标识、窄屏导航、搜索和 Web/CLI interface guide。

验证

  • pnpm --dir website check：格式、生产构建、内部链接通过。
  • 共享模板分别构建了 Core 的 Memos global/python 文档和 Web 的 module-federation 文档；跨 pnpm workspace 的锁定安装命令已真实验证。
  • Registry Toolkit 已把真实 VitePress 输出打包为合法候选；Registry 的另一种手写静态站点格式由服务端验收覆盖，证明合同不耦合 VitePress。
  • Memos setup 的一次性真实 Core/PostgREST 验收覆盖 PAT 生成/复用、响应丢失恢复、真实 memo 创建/列出/删除和桌面/390px 页面；截图隐藏 PAT，验收后凭据已撤销。
  • 既有 Cloudflare Pages preview、RSS 首次采集/304/索引检索、公开 Twitter0.4/Mail0.3 MF 验收保持有效。

协同交付与边界

Core #110 提供 Heroku/Core 接入能力，并承载 Memos global/python 文档。Web Memos setup 与 Registry 托管实现仍在本地等待一次性复审，尚无提交、PR 或生产部署。RSS/GitHub 不做 setup wizard；Mail/Telegram 的初始化归 Source/Config；Twitter 保持现状。

稳定预览入口：Docs PR28 preview。用户页面不包含临时 PR 待合并提示；跨仓库依赖只记录在此。PR 保持 ready，本轮不合并。

@xiaoland
xiaoland marked this pull request as ready for review September 20, 2026 07:51
@xiaoland xiaoland changed the title docs(self-hosted): 增加面向用户的自部署入门指南 docs(onboarding): 帮助用户开始使用 InKCre Sep 20, 2026
This was referenced Sep 20, 2026
Open
Merged
@xiaoland
docs(self-hosted): 增加面向用户的自部署入门指南
1a63c2b 
- 提供 Neon + Render/Heroku 快速部署与手动部署路径
- 串联 CLI、信息源采集、索引检索和日常客户端使用
- 新增 Self-Hosted 导航与概览
@xiaoland
fix(preview): 将预览状态和入口关联到 PR 提交
a1928a3 
- 在精确 PR head 上报告 pending、成功或错误状态
- 保留现有部署和清理流程，并说明 main 控制器生效边界
@xiaoland
docs(preview): 格式化预览发布说明
706d49d
@xiaoland
docs(onboarding): 区分应用入门与自部署指南
58800a8 
- 首页 Getting Started 介绍 What、Why、How 与实例访问路径
- Self-Hosted 下区分 Getting Started 和 Advanced
- 将手动部署迁至进阶指南并保留原入口跳转
@xiaoland
docs(guides): 拆分可复用的用户操作与部署指南
baf8c03 
- 自部署 Getting Started 仅编排阅读路径
- 独立提供连接、采集、检索、定时任务、来源、日常使用及排障指南
- Render 和 Heroku 部署分别成页，跨文档复用改用页面链接
@xiaoland
docs(sinks): 增加 ChatGPT MCP 与 tunnel 配置教程
6478473 
- 覆盖 Sink 创建、凭据分离、tunnel 鉴权和 ChatGPT 连接
- 以真实工具检索作为验收点，说明 Skill 导入限制
- 增加停用步骤与常见故障排查
@xiaoland
docs(onboarding): 拆分来源教程并补充生态扩展开发指南
2163c3a 
- 为 RSS、GitHub、邮件、Telegram、Twitter 和 Memos 提供独立上手路径
- 分离首次采集入口与共享 Job 操作，增加 Source Extension 构建及私有预览教程
- 核对发行版本并验证示例打包、授权请求和网站构建
@xiaoland
docs(guides): 优先展示 Web 操作并提供 Agent 指南切换
dc97b37 
- 补齐 Twitter setup wizard 与六种来源的可视化步骤
- 共享连接和扩展准备入口，修正浏览器自动注册说明
- 明确安装、索引维护及 Twitter 双端发行兼容边界
@xiaoland
docs(onboarding): 对齐 Web 安装和双 Host 兼容发行流程
b0a6caa 
- 从来源指南移除必须委托 Agent 安装的前置步骤
- 明确 Core 选择、单独启用、版本保护与 Twitter 同版本向导
@xiaoland
docs(extensions): 确立静态文档托管跨仓库合同
fc8b255 
- 区分 global、Python 与 MF 文档集及第一方源所有权
- 约定精确版本发现、整包条件更新与独立快照隔离
- 保持 Release 安装协议、代码产物与文档纠错相互独立
@xiaoland
xiaoland force-pushed the feat/user-getting-started branch from e15a03f to fc8b255 Compare September 20, 2026 15:47
@xiaoland
feat(docs): 提供第一方插件静态文档模板
17af8b6 
- 复用共享主题、界面切换和本地搜索\n- 显示精确发行版本与文档渠道，支持跨仓库构建
@xiaoland
docs(extensions): 修正文档模板跨工作区安装命令
5aa97e6 
- 使用共享网站自己的锁文件和工具链\n- 避免消费者 pnpm workspace 吞并模板依赖
This was referenced Sep 21, 2026
Draft
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@xiaoland